Skip to content

KNOX-3318: document LDAP service#1227

Merged
smolnar82 merged 2 commits into
apache:masterfrom
smolnar82:KNOX-3318
Jun 4, 2026
Merged

KNOX-3318: document LDAP service#1227
smolnar82 merged 2 commits into
apache:masterfrom
smolnar82:KNOX-3318

Conversation

@smolnar82
Copy link
Copy Markdown
Contributor

KNOX-3318 - Add Knox LDAP Server documentation to User Guide

What changes were proposed in this pull request?

This pull request adds comprehensive documentation for the Knox LDAP Server feature (introduced in KNOX-3247 and improved in KNOX-3277) to the official Knox User Guide.

Changes include:

  • Created knox-site/docs/service_ldap_server.md which provides:
    • An architectural overview of the embedded ApacheDS-based LDAP service.
    • Detailed configuration instructions for both file and proxy backends.
    • Specific guidance for Active Directory (AD) integration, including memberOf and sAMAccountName support.
    • Troubleshooting tips regarding logs and lock files.
  • Updated knox-site/mkdocs.yml to include the "LDAP Server" page in the Client/User Guide navigation.
  • Updated knox-site/docs/book_service-details.md to include the LDAP Server in the master list of supported services.

How was this patch tested?

  • Manually verified the Markdown rendering and formatting of the new documentation.
  • Validated all internal and external (JIRA) links.
  • Cross-referenced all configuration property names (e.g., gateway.ldap.backend.proxy.*) with the implementation in GatewayConfigImpl.java and LdapProxyBackend.java to ensure accuracy.

Integration Tests

N/A - This is a documentation-only change. No functional code was modified.

UI changes

N/A

@smolnar82 smolnar82 self-assigned this May 11, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 11, 2026

Test Results

22 tests   22 ✅  1s ⏱️
 1 suites   0 💤
 1 files     0 ❌

Results for commit d83d11a.

♻️ This comment has been updated with latest results.

@smolnar82
Copy link
Copy Markdown
Contributor Author

Cc. @handavid

Copy link
Copy Markdown
Contributor

@Raghav-Mah3shwari Raghav-Mah3shwari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread knox-site/docs/service_ldap_server.md Outdated
Comment thread knox-site/docs/service_ldap_server.md Outdated
Comment thread knox-site/docs/service_ldap_server.md Outdated
Comment thread knox-site/docs/service_ldap_server.md Outdated
@smolnar82 smolnar82 merged commit d1c3046 into apache:master Jun 4, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants